ObsidianHtml Config
2024-09-30
1. Defining the Site Name & Path
- I like to keep the configuration clean and concise. For instance, setting a visually appealing site name, in this case,
"🌺 ☁️ ⚡️"
, keeps things light and creative. - The
obsidian_entrypoint_path_str
defines the starting point, which here is./journal/Journal.md
, ensuring that I can keep all journal files organized and easily accessible.
2. Customization with Toggles
- Process All: This ensures that all files are processed, preventing the need to pick individual files later.
- External Links: By setting
external_blank: True
, I make sure all external links open in a new tab, preserving the user’s experience on the primary site.
3. Selective Feature Activation I prefer to keep things modular by enabling or disabling certain features as per current needs:
- Backlinks and Graph: Both are disabled, as I currently don’t require cross-referencing within notes.
- Directory Indexing: I’ve enabled
create_index_from_dir_structure
, allowing easy navigation through the directory structure without manually creating indexes.
4. Layout and Styling
- Tabs Layout: I've chosen the
tabs
layout, which suits the multi-note navigation in my journal. - Styling: I keep styling flexible by avoiding fixed accents or colors. The commented-out option to set an accent color like
#151515
gives me space to tweak the aesthetics later.
5. Exploration and Future Enhancements I intentionally leave several configuration options commented out, ready for future exploration. These include:
- Side Pane and Directory Tree: I haven’t enabled the directory tree in the side pane, but the configuration is commented and ready to go if I decide to enable it later.
- Custom Inclusions: There’s an option to include custom HTML or CSS via the
html_custom_inclusions
section, making the setup highly customizable. - Navbar Links: Similarly, I have placeholders for navigational links like "Open Notes" and "Creative Lab," which I can activate once I need a more complex navigation structure.
```
site_name: "🌺 ☁️ ⚡️"
html_url_prefix: ""
# The first folder that contains all obsidian files
# Use full path or relative path, but don't use ~/
obsidian_entrypoint_path_str: "./journal/Journal.md"
toggles:
process_all: True
external_blank: True
features:
backlinks:
enabled: False
graph:
enabled: False
create_index_from_tags:
enabled: False
create_index_from_dir_structure:
enabled: True
theme_picker:
enabled: False
search:
enabled: True
tags_page:
enabled: False
backlinks:
enabled: True
styling:
# accent_color: "#151515"
add_dir_list: False
layout: tabs # documentation, tabs, minimal
# Correct dark theme configuration using the 'smiles' feature
# Enable the directory tree in the side pane
# side_pane:
# left_pane:
# enabled: False
# close_if_empty: False
# width: 20rem
# contents: dir_tree # Enables the directory tree
# right_pane:
# enabled: False
# close_if_empty: True
# width: 16rem
# contents: toc # Optional: Table of Contents in the right pane
# html_custom_inclusions:
# - ''
# navbar_links:
# - name: Open Notes
# link: notes/open-notes/Open Notes.html
# - name: Creative Lab
# link: notes/creative-lab/Creative Lab.html
# - name: Learn Camp
# link: notes/learn-camp/Learn Camp.html
# - name: Strategy Studio
# link: notes/strategy-studio/Strategy Studio.html```